<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    /*<a name="line.1"></a>
<FONT color="green">002</FONT>     Copyright 2009-2010<a name="line.2"></a>
<FONT color="green">003</FONT>     Ubiquitous Knowledge Processing (UKP) Lab<a name="line.3"></a>
<FONT color="green">004</FONT>     Technische Universitaet Darmstadt<a name="line.4"></a>
<FONT color="green">005</FONT>     All rights reserved.<a name="line.5"></a>
<FONT color="green">006</FONT>    <a name="line.6"></a>
<FONT color="green">007</FONT>     Licensed under the Apache License, Version 2.0 (the "License");<a name="line.7"></a>
<FONT color="green">008</FONT>     you may not use this file except in compliance with the License.<a name="line.8"></a>
<FONT color="green">009</FONT>     You may obtain a copy of the License at<a name="line.9"></a>
<FONT color="green">010</FONT>    <a name="line.10"></a>
<FONT color="green">011</FONT>     http://www.apache.org/licenses/LICENSE-2.0<a name="line.11"></a>
<FONT color="green">012</FONT>    <a name="line.12"></a>
<FONT color="green">013</FONT>     Unless required by applicable law or agreed to in writing, software<a name="line.13"></a>
<FONT color="green">014</FONT>     distributed under the License is distributed on an "AS IS" BASIS,<a name="line.14"></a>
<FONT color="green">015</FONT>     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.15"></a>
<FONT color="green">016</FONT>     See the License for the specific language governing permissions and<a name="line.16"></a>
<FONT color="green">017</FONT>     limitations under the License.<a name="line.17"></a>
<FONT color="green">018</FONT>     */<a name="line.18"></a>
<FONT color="green">019</FONT>    <a name="line.19"></a>
<FONT color="green">020</FONT>    package org.uimafit.util;<a name="line.20"></a>
<FONT color="green">021</FONT>    <a name="line.21"></a>
<FONT color="green">022</FONT>    import static org.uimafit.util.CasUtil.select;<a name="line.22"></a>
<FONT color="green">023</FONT>    import static org.uimafit.util.CasUtil.selectCovered;<a name="line.23"></a>
<FONT color="green">024</FONT>    <a name="line.24"></a>
<FONT color="green">025</FONT>    import java.util.Collection;<a name="line.25"></a>
<FONT color="green">026</FONT>    import java.util.Collections;<a name="line.26"></a>
<FONT color="green">027</FONT>    import java.util.LinkedHashMap;<a name="line.27"></a>
<FONT color="green">028</FONT>    import java.util.LinkedList;<a name="line.28"></a>
<FONT color="green">029</FONT>    import java.util.Map;<a name="line.29"></a>
<FONT color="green">030</FONT>    <a name="line.30"></a>
<FONT color="green">031</FONT>    import org.apache.uima.cas.CAS;<a name="line.31"></a>
<FONT color="green">032</FONT>    import org.apache.uima.cas.text.AnnotationFS;<a name="line.32"></a>
<FONT color="green">033</FONT>    import org.apache.uima.jcas.JCas;<a name="line.33"></a>
<FONT color="green">034</FONT>    <a name="line.34"></a>
<FONT color="green">035</FONT>    /**<a name="line.35"></a>
<FONT color="green">036</FONT>     * Create a fast way of repeatedly checking whether instances of one type are contained within the<a name="line.36"></a>
<FONT color="green">037</FONT>     * boundaries on another type.<a name="line.37"></a>
<FONT color="green">038</FONT>     *<a name="line.38"></a>
<FONT color="green">039</FONT>     * @author Richard Eckart de Castilho<a name="line.39"></a>
<FONT color="green">040</FONT>     *<a name="line.40"></a>
<FONT color="green">041</FONT>     * @param &lt;S&gt;<a name="line.41"></a>
<FONT color="green">042</FONT>     *            covering type.<a name="line.42"></a>
<FONT color="green">043</FONT>     * @param &lt;U&gt;<a name="line.43"></a>
<FONT color="green">044</FONT>     *            covered type.<a name="line.44"></a>
<FONT color="green">045</FONT>     */<a name="line.45"></a>
<FONT color="green">046</FONT>    public class ContainmentIndex&lt;S extends AnnotationFS, U extends AnnotationFS&gt; {<a name="line.46"></a>
<FONT color="green">047</FONT>            public static enum Type {<a name="line.47"></a>
<FONT color="green">048</FONT>                    DIRECT, REVERSE, BOTH<a name="line.48"></a>
<FONT color="green">049</FONT>            }<a name="line.49"></a>
<FONT color="green">050</FONT>    <a name="line.50"></a>
<FONT color="green">051</FONT>            private Map&lt;AnnotationFS, Collection&lt;AnnotationFS&gt;&gt; data =<a name="line.51"></a>
<FONT color="green">052</FONT>                    new LinkedHashMap&lt;AnnotationFS, Collection&lt;AnnotationFS&gt;&gt;();<a name="line.52"></a>
<FONT color="green">053</FONT>            private Map&lt;AnnotationFS, Collection&lt;AnnotationFS&gt;&gt; dataRev =<a name="line.53"></a>
<FONT color="green">054</FONT>                    new LinkedHashMap&lt;AnnotationFS, Collection&lt;AnnotationFS&gt;&gt;();<a name="line.54"></a>
<FONT color="green">055</FONT>    <a name="line.55"></a>
<FONT color="green">056</FONT>            /**<a name="line.56"></a>
<FONT color="green">057</FONT>             * Create a new index on the given JCas using the specified two types. The last argument<a name="line.57"></a>
<FONT color="green">058</FONT>             * indicates in which directions lookups to the index will be made.<a name="line.58"></a>
<FONT color="green">059</FONT>             *<a name="line.59"></a>
<FONT color="green">060</FONT>             * @param cas<a name="line.60"></a>
<FONT color="green">061</FONT>             *            the working JCas.<a name="line.61"></a>
<FONT color="green">062</FONT>             * @param aSuper<a name="line.62"></a>
<FONT color="green">063</FONT>             *            the covering type.<a name="line.63"></a>
<FONT color="green">064</FONT>             * @param aUnder<a name="line.64"></a>
<FONT color="green">065</FONT>             *            the covered type.<a name="line.65"></a>
<FONT color="green">066</FONT>             * @param aType<a name="line.66"></a>
<FONT color="green">067</FONT>             *            the indexing strategy.<a name="line.67"></a>
<FONT color="green">068</FONT>             */<a name="line.68"></a>
<FONT color="green">069</FONT>            public ContainmentIndex(CAS cas, org.apache.uima.cas.Type aSuper, org.apache.uima.cas.Type aUnder,<a name="line.69"></a>
<FONT color="green">070</FONT>                            Type aType) {<a name="line.70"></a>
<FONT color="green">071</FONT>                    Collection&lt;AnnotationFS&gt; over = select(cas, aSuper);<a name="line.71"></a>
<FONT color="green">072</FONT>                    for (AnnotationFS s : over) {<a name="line.72"></a>
<FONT color="green">073</FONT>                            Collection&lt;AnnotationFS&gt; under = selectCovered(cas, aUnder, s);<a name="line.73"></a>
<FONT color="green">074</FONT>                            for (AnnotationFS u : under) {<a name="line.74"></a>
<FONT color="green">075</FONT>                                    switch (aType) {<a name="line.75"></a>
<FONT color="green">076</FONT>                                    case DIRECT: {<a name="line.76"></a>
<FONT color="green">077</FONT>                                            put(data, s, u);<a name="line.77"></a>
<FONT color="green">078</FONT>                                            break;<a name="line.78"></a>
<FONT color="green">079</FONT>                                    }<a name="line.79"></a>
<FONT color="green">080</FONT>                                    case REVERSE:<a name="line.80"></a>
<FONT color="green">081</FONT>                                            put(dataRev, u, s);<a name="line.81"></a>
<FONT color="green">082</FONT>                                            break;<a name="line.82"></a>
<FONT color="green">083</FONT>                                    case BOTH:<a name="line.83"></a>
<FONT color="green">084</FONT>                                            put(data, s, u);<a name="line.84"></a>
<FONT color="green">085</FONT>                                            put(dataRev, u, s);<a name="line.85"></a>
<FONT color="green">086</FONT>                                            break;<a name="line.86"></a>
<FONT color="green">087</FONT>                                    }<a name="line.87"></a>
<FONT color="green">088</FONT>                            }<a name="line.88"></a>
<FONT color="green">089</FONT>                    }<a name="line.89"></a>
<FONT color="green">090</FONT>            }<a name="line.90"></a>
<FONT color="green">091</FONT>    <a name="line.91"></a>
<FONT color="green">092</FONT>            private &lt;X, Y&gt; void put(Map&lt;X, Collection&lt;Y&gt;&gt; map, X key, Y value) {<a name="line.92"></a>
<FONT color="green">093</FONT>                    Collection&lt;Y&gt; c = map.get(key);<a name="line.93"></a>
<FONT color="green">094</FONT>                    if (c == null) {<a name="line.94"></a>
<FONT color="green">095</FONT>                            c = new LinkedList&lt;Y&gt;();<a name="line.95"></a>
<FONT color="green">096</FONT>                            map.put(key, c);<a name="line.96"></a>
<FONT color="green">097</FONT>                    }<a name="line.97"></a>
<FONT color="green">098</FONT>                    c.add(value);<a name="line.98"></a>
<FONT color="green">099</FONT>            }<a name="line.99"></a>
<FONT color="green">100</FONT>    <a name="line.100"></a>
<FONT color="green">101</FONT>            /**<a name="line.101"></a>
<FONT color="green">102</FONT>             * Get all instances of the covered type contained within the boundaries of the specified<a name="line.102"></a>
<FONT color="green">103</FONT>             * instance of the covering type.<a name="line.103"></a>
<FONT color="green">104</FONT>             *<a name="line.104"></a>
<FONT color="green">105</FONT>             * @param aSuper<a name="line.105"></a>
<FONT color="green">106</FONT>             *            a covering type instance.<a name="line.106"></a>
<FONT color="green">107</FONT>             * @return a collection of covered type instances.<a name="line.107"></a>
<FONT color="green">108</FONT>             */<a name="line.108"></a>
<FONT color="green">109</FONT>            @SuppressWarnings("unchecked")<a name="line.109"></a>
<FONT color="green">110</FONT>            public Collection&lt;U&gt; containedIn(S aSuper) {<a name="line.110"></a>
<FONT color="green">111</FONT>                    @SuppressWarnings("rawtypes")<a name="line.111"></a>
<FONT color="green">112</FONT>                    Collection c = data.get(aSuper);<a name="line.112"></a>
<FONT color="green">113</FONT>                    if (c == null) {<a name="line.113"></a>
<FONT color="green">114</FONT>                            return Collections.emptySet();<a name="line.114"></a>
<FONT color="green">115</FONT>                    }<a name="line.115"></a>
<FONT color="green">116</FONT>                    return c;<a name="line.116"></a>
<FONT color="green">117</FONT>            }<a name="line.117"></a>
<FONT color="green">118</FONT>    <a name="line.118"></a>
<FONT color="green">119</FONT>            /**<a name="line.119"></a>
<FONT color="green">120</FONT>             * Get all instances of the covering type containing the the specified instance of the covered<a name="line.120"></a>
<FONT color="green">121</FONT>             * type.<a name="line.121"></a>
<FONT color="green">122</FONT>             *<a name="line.122"></a>
<FONT color="green">123</FONT>             * @param aUnder<a name="line.123"></a>
<FONT color="green">124</FONT>             *            a covered type instance.<a name="line.124"></a>
<FONT color="green">125</FONT>             * @return a collection of covering type instances.<a name="line.125"></a>
<FONT color="green">126</FONT>             */<a name="line.126"></a>
<FONT color="green">127</FONT>            @SuppressWarnings("unchecked")<a name="line.127"></a>
<FONT color="green">128</FONT>            public Collection&lt;S&gt; containing(U aUnder) {<a name="line.128"></a>
<FONT color="green">129</FONT>                    @SuppressWarnings("rawtypes")<a name="line.129"></a>
<FONT color="green">130</FONT>                    Collection c = dataRev.get(aUnder);<a name="line.130"></a>
<FONT color="green">131</FONT>                    if (c == null) {<a name="line.131"></a>
<FONT color="green">132</FONT>                            return Collections.emptySet();<a name="line.132"></a>
<FONT color="green">133</FONT>                    }<a name="line.133"></a>
<FONT color="green">134</FONT>                    return c;<a name="line.134"></a>
<FONT color="green">135</FONT>            }<a name="line.135"></a>
<FONT color="green">136</FONT>    <a name="line.136"></a>
<FONT color="green">137</FONT>            /**<a name="line.137"></a>
<FONT color="green">138</FONT>             * Checks if the given covered type is contained in the specified covering type.<a name="line.138"></a>
<FONT color="green">139</FONT>             *<a name="line.139"></a>
<FONT color="green">140</FONT>             * @param aSuper<a name="line.140"></a>
<FONT color="green">141</FONT>             *            the covering type instance.<a name="line.141"></a>
<FONT color="green">142</FONT>             * @param aUnder<a name="line.142"></a>
<FONT color="green">143</FONT>             *            the covered type instance.<a name="line.143"></a>
<FONT color="green">144</FONT>             * @return whether the covered instance is contained in the covering instance.<a name="line.144"></a>
<FONT color="green">145</FONT>             */<a name="line.145"></a>
<FONT color="green">146</FONT>            public boolean isContainedIn(S aSuper, U aUnder) {<a name="line.146"></a>
<FONT color="green">147</FONT>                    return containedIn(aSuper).contains(aUnder);<a name="line.147"></a>
<FONT color="green">148</FONT>            }<a name="line.148"></a>
<FONT color="green">149</FONT>    <a name="line.149"></a>
<FONT color="green">150</FONT>            /**<a name="line.150"></a>
<FONT color="green">151</FONT>             * Checks if the given covered type is contained in any instance of the covering type.<a name="line.151"></a>
<FONT color="green">152</FONT>             *<a name="line.152"></a>
<FONT color="green">153</FONT>             * @param aUnder<a name="line.153"></a>
<FONT color="green">154</FONT>             *            the covered type instance.<a name="line.154"></a>
<FONT color="green">155</FONT>             * @return whether the covered instance is contained in any instance of the covering type.<a name="line.155"></a>
<FONT color="green">156</FONT>             */<a name="line.156"></a>
<FONT color="green">157</FONT>            public boolean isContainedInAny(U aUnder) {<a name="line.157"></a>
<FONT color="green">158</FONT>                    Collection&lt;S&gt; containers = containing(aUnder);<a name="line.158"></a>
<FONT color="green">159</FONT>                    return containers != null &amp;&amp; !containers.isEmpty();<a name="line.159"></a>
<FONT color="green">160</FONT>            }<a name="line.160"></a>
<FONT color="green">161</FONT>    <a name="line.161"></a>
<FONT color="green">162</FONT>            /**<a name="line.162"></a>
<FONT color="green">163</FONT>             * Factory method to create an index instead of using the constructor. This makes used of Java's<a name="line.163"></a>
<FONT color="green">164</FONT>             * type inference capabilities and results in less verbose code.<a name="line.164"></a>
<FONT color="green">165</FONT>             *<a name="line.165"></a>
<FONT color="green">166</FONT>             * @param &lt;A&gt;<a name="line.166"></a>
<FONT color="green">167</FONT>             *            covering type.<a name="line.167"></a>
<FONT color="green">168</FONT>             * @param &lt;B&gt;<a name="line.168"></a>
<FONT color="green">169</FONT>             *            covered type.<a name="line.169"></a>
<FONT color="green">170</FONT>             * @param aJcas<a name="line.170"></a>
<FONT color="green">171</FONT>             *            the working JCas.<a name="line.171"></a>
<FONT color="green">172</FONT>             * @param aSuper<a name="line.172"></a>
<FONT color="green">173</FONT>             *            the covering type.<a name="line.173"></a>
<FONT color="green">174</FONT>             * @param aUnder<a name="line.174"></a>
<FONT color="green">175</FONT>             *            the covered type.<a name="line.175"></a>
<FONT color="green">176</FONT>             * @param aType<a name="line.176"></a>
<FONT color="green">177</FONT>             *            the indexing strategy.<a name="line.177"></a>
<FONT color="green">178</FONT>             * @return the index instance.<a name="line.178"></a>
<FONT color="green">179</FONT>             */<a name="line.179"></a>
<FONT color="green">180</FONT>            @SuppressWarnings("unchecked")<a name="line.180"></a>
<FONT color="green">181</FONT>            public static &lt;A extends AnnotationFS, B extends AnnotationFS&gt; ContainmentIndex&lt;A, B&gt; create(<a name="line.181"></a>
<FONT color="green">182</FONT>                            JCas aJcas, Class&lt;A&gt; aSuper, Class&lt;B&gt; aUnder, Type aType) {<a name="line.182"></a>
<FONT color="green">183</FONT>                    return (ContainmentIndex&lt;A, B&gt;) create(aJcas.getCas(), JCasUtil.getType(aJcas, aSuper),<a name="line.183"></a>
<FONT color="green">184</FONT>                                    JCasUtil.getType(aJcas, aUnder), aType);<a name="line.184"></a>
<FONT color="green">185</FONT>            }<a name="line.185"></a>
<FONT color="green">186</FONT>    <a name="line.186"></a>
<FONT color="green">187</FONT>            /**<a name="line.187"></a>
<FONT color="green">188</FONT>             * Factory method to create an index instead of using the constructor. This makes used of Java's<a name="line.188"></a>
<FONT color="green">189</FONT>             * type inference capabilities and results in less verbose code.<a name="line.189"></a>
<FONT color="green">190</FONT>             *<a name="line.190"></a>
<FONT color="green">191</FONT>             * @param cas<a name="line.191"></a>
<FONT color="green">192</FONT>             *            the working JCas.<a name="line.192"></a>
<FONT color="green">193</FONT>             * @param aSuper<a name="line.193"></a>
<FONT color="green">194</FONT>             *            the covering type.<a name="line.194"></a>
<FONT color="green">195</FONT>             * @param aUnder<a name="line.195"></a>
<FONT color="green">196</FONT>             *            the covered type.<a name="line.196"></a>
<FONT color="green">197</FONT>             * @param aType<a name="line.197"></a>
<FONT color="green">198</FONT>             *            the indexing strategy.<a name="line.198"></a>
<FONT color="green">199</FONT>             * @return the index instance.<a name="line.199"></a>
<FONT color="green">200</FONT>             */<a name="line.200"></a>
<FONT color="green">201</FONT>            public static ContainmentIndex&lt;AnnotationFS, AnnotationFS&gt; create(<a name="line.201"></a>
<FONT color="green">202</FONT>                            CAS cas, org.apache.uima.cas.Type aSuper, org.apache.uima.cas.Type aUnder, Type aType) {<a name="line.202"></a>
<FONT color="green">203</FONT>                    return new ContainmentIndex&lt;AnnotationFS, AnnotationFS&gt;(cas, aSuper, aUnder, aType);<a name="line.203"></a>
<FONT color="green">204</FONT>            }<a name="line.204"></a>
<FONT color="green">205</FONT>    }<a name="line.205"></a>




























































</PRE>
</BODY>
</HTML>
